<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>lgtunit &mdash; Logtalk APIs v3.93.0-b01 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d75fae25" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=0e9007aa" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=c8100655"></script>
        <script src="_static/doctools.js?v=9a2dae69"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <!-- begin favicon -->
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
    <link rel="manifest" href="/site.webmanifest" />
    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5" />
    <meta name="msapplication-TileColor" content="#355b95" />
    <meta name="theme-color" content="#ffffff" />
    <!-- end favicon -->
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="lgtunit_messages" href="lgtunit_messages_0.html" />
    <link rel="prev" title="coverage_report" href="coverage_report_0.html" />
   
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html" class="icon icon-home">
            Logtalk APIs
              <img src="_static/logtalk.gif" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                3.93.0
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    
              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="library_index.html">Libraries</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="library_index.html#arbitrary"><span class="xref std std-ref">arbitrary</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#assertions"><span class="xref std std-ref">assertions</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#assignvars"><span class="xref std std-ref">assignvars</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#base64"><span class="xref std std-ref">base64</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#cbor"><span class="xref std std-ref">cbor</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#code-metrics"><span class="xref std std-ref">code_metrics</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#core"><span class="xref std std-ref">core</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#coroutining"><span class="xref std std-ref">coroutining</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#csv"><span class="xref std std-ref">csv</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dates"><span class="xref std std-ref">dates</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dead-code-scanner"><span class="xref std std-ref">dead_code_scanner</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#debug-messages"><span class="xref std std-ref">debug_messages</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#debugger"><span class="xref std std-ref">debugger</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dependents"><span class="xref std std-ref">dependents</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#diagrams"><span class="xref std std-ref">diagrams</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dictionaries"><span class="xref std std-ref">dictionaries</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dif"><span class="xref std std-ref">dif</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#doclet"><span class="xref std std-ref">doclet</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#edcg"><span class="xref std std-ref">edcg</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#events"><span class="xref std std-ref">events</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#expand-library-alias-paths"><span class="xref std std-ref">expand_library_alias_paths</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#expecteds"><span class="xref std std-ref">expecteds</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#fcube"><span class="xref std std-ref">fcube</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#flags"><span class="xref std std-ref">flags</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#format"><span class="xref std std-ref">format</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#genint"><span class="xref std std-ref">genint</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#gensym"><span class="xref std std-ref">gensym</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#git"><span class="xref std std-ref">git</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#grammars"><span class="xref std std-ref">grammars</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#heaps"><span class="xref std std-ref">heaps</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#help"><span class="xref std std-ref">help</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hierarchies"><span class="xref std std-ref">hierarchies</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hook-flows"><span class="xref std std-ref">hook_flows</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hook-objects"><span class="xref std std-ref">hook_objects</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#html"><span class="xref std std-ref">html</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ids"><span class="xref std std-ref">ids</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#intervals"><span class="xref std std-ref">intervals</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#iso8601"><span class="xref std std-ref">iso8601</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#issue-creator"><span class="xref std std-ref">issue_creator</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#java"><span class="xref std std-ref">java</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#json"><span class="xref std std-ref">json</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#json-lines"><span class="xref std std-ref">json_lines</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#lgtdoc"><span class="xref std std-ref">lgtdoc</span></a></li>
<li class="toctree-l2 current"><a class="reference internal" href="library_index.html#lgtunit"><span class="xref std std-ref">lgtunit</span></a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="automation_report_0.html">automation_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="coverage_report_0.html">coverage_report</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">lgtunit</a></li>
<li class="toctree-l3"><a class="reference internal" href="lgtunit_messages_0.html">lgtunit_messages</a></li>
<li class="toctree-l3"><a class="reference internal" href="minimal_output_0.html">minimal_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="tap_output_0.html">tap_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="tap_report_0.html">tap_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_net_v2_output_0.html">xunit_net_v2_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_net_v2_report_0.html">xunit_net_v2_report</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_output_0.html">xunit_output</a></li>
<li class="toctree-l3"><a class="reference internal" href="xunit_report_0.html">xunit_report</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#library"><span class="xref std std-ref">library</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#listing"><span class="xref std std-ref">listing</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#logging"><span class="xref std std-ref">logging</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#loops"><span class="xref std std-ref">loops</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#meta"><span class="xref std std-ref">meta</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#meta-compiler"><span class="xref std std-ref">meta_compiler</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#metagol"><span class="xref std std-ref">metagol</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#mutations"><span class="xref std std-ref">mutations</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#nested-dictionaries"><span class="xref std std-ref">nested_dictionaries</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#optionals"><span class="xref std std-ref">optionals</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#options"><span class="xref std std-ref">options</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#os"><span class="xref std std-ref">os</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#packs"><span class="xref std std-ref">packs</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#pddl-parser"><span class="xref std std-ref">pddl_parser</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ports-profiler"><span class="xref std std-ref">ports_profiler</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#queues"><span class="xref std std-ref">queues</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#random"><span class="xref std std-ref">random</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#reader"><span class="xref std std-ref">reader</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#recorded-database"><span class="xref std std-ref">recorded_database</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#redis"><span class="xref std std-ref">redis</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#sets"><span class="xref std std-ref">sets</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#statistics"><span class="xref std std-ref">statistics</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#term-io"><span class="xref std std-ref">term_io</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#timeout"><span class="xref std std-ref">timeout</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#toychr"><span class="xref std std-ref">toychr</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#tsv"><span class="xref std std-ref">tsv</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#tutor"><span class="xref std std-ref">tutor</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#types"><span class="xref std std-ref">types</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ulid"><span class="xref std std-ref">ulid</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#union-find"><span class="xref std std-ref">union_find</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#uuid"><span class="xref std std-ref">uuid</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#verdi-neruda"><span class="xref std std-ref">verdi_neruda</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#wrapper"><span class="xref std std-ref">wrapper</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#xml-parser"><span class="xref std std-ref">xml_parser</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#zippers"><span class="xref std std-ref">zippers</span></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="directory_index.html">Directories</a></li>
<li class="toctree-l1"><a class="reference internal" href="entity_index.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="predicate_index.html">Predicates</a></li>
</ul>

    <ul>
    <li class="toctree-l1"><a class="reference internal" href="core_inheritance_diagram.svg">Core diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="library_inheritance_diagram.svg">Libraries diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="tools_inheritance_diagram.svg">Tools diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="ports_inheritance_diagram.svg">Ports diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="contributions_inheritance_diagram.svg">Contributions diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
    </ul>
    <p class="caption"><span class="caption-text">External Contents</span></p>
    <ul>
    <li class="toctree-l1"><a class="reference internal" href="../handbook/index.html">Handbook</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://logtalk.org">Logtalk website</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://github.com/LogtalkDotOrg/logtalk3">GitHub repo</a></li>
    </ul>
  
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Logtalk APIs</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="library_index.html">Libraries</a></li>
      <li class="breadcrumb-item active"><code class="docutils literal notranslate"><span class="pre">lgtunit</span></code></li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/lgtunit_0.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <p class="right" id="lgtunit-0"><span id="index-0"></span><strong>object</strong></p>
<section id="lgtunit">
<h1><code class="docutils literal notranslate"><span class="pre">lgtunit</span></code><a class="headerlink" href="#lgtunit" title="Link to this heading"></a></h1>
<p>A unit test framework supporting predicate clause coverage, determinism testing, input/output testing, property-based testing, and multiple test dialects.</p>
<div class="line-block">
<div class="line"><strong>Availability:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">logtalk_load(lgtunit(loader))</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Author:</strong> Paulo Moura</div>
<div class="line"><strong>Version:</strong> 21:0:0</div>
<div class="line"><strong>Date:</strong> 2025-04-07</div>
</div>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static,</span> <span class="pre">context_switching_calls</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Implements:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">public</span></code> <a class="reference internal" href="expanding_0.html#expanding-0"><span class="std std-ref">expanding</span></a></div>
</div>
<div class="line"><strong>Provides:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="logtalk_0.html#logtalk-0-trace-event-2"><span class="std std-ref">logtalk::trace_event/2</span></a></div>
</div>
<div class="line"><strong>Uses:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="fast_random_0.html#fast-random-0"><span class="std std-ref">fast_random</span></a></div>
<div class="line"><a class="reference internal" href="list_0.html#list-0"><span class="std std-ref">list</span></a></div>
<div class="line"><a class="reference internal" href="logtalk_0.html#logtalk-0"><span class="std std-ref">logtalk</span></a></div>
<div class="line"><a class="reference internal" href="os_0.html#os-0"><span class="std std-ref">os</span></a></div>
<div class="line"><a class="reference internal" href="type_0.html#type-0"><span class="std std-ref">type</span></a></div>
<div class="line"><a class="reference internal" href="user_0.html#user-0"><span class="std std-ref">user</span></a></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
</div>
<blockquote>
<div><ul class="simple">
<li><p>Usage: Define test objects as extensions of the <code class="docutils literal notranslate"><span class="pre">lgtunit</span></code> object and compile their source files using the compiler option <code class="docutils literal notranslate"><span class="pre">hook(lgtunit)</span></code>.</p></li>
<li><p>Portability: Deterministic unit tests are currently not available when using Quintus Prolog as the backend compiler.</p></li>
<li><p>Known issues: Parameter variables cannot currently be used in the definition of test options.</p></li>
</ul>
</div></blockquote>
<div class="line-block">
<div class="line"><strong>Inherited public predicates:</strong></div>
<div class="line-block">
<div class="line"> <a class="reference internal" href="expanding_0.html#expanding-0-goal-expansion-2"><span class="std std-ref">goal_expansion/2</span></a>  <a class="reference internal" href="expanding_0.html#expanding-0-term-expansion-2"><span class="std std-ref">term_expansion/2</span></a></div>
</div>
</div>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#public-predicates" id="id4">Public predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#cover-1" id="id5"><code class="docutils literal notranslate"><span class="pre">cover/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#run-0" id="id6"><code class="docutils literal notranslate"><span class="pre">run/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#run-1" id="id7"><code class="docutils literal notranslate"><span class="pre">run/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#run-2" id="id8"><code class="docutils literal notranslate"><span class="pre">run/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#run-test-sets-1" id="id9"><code class="docutils literal notranslate"><span class="pre">run_test_sets/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#test-1" id="id10"><code class="docutils literal notranslate"><span class="pre">test/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#number-of-tests-1" id="id11"><code class="docutils literal notranslate"><span class="pre">number_of_tests/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#deterministic-1" id="id12"><code class="docutils literal notranslate"><span class="pre">deterministic/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#deterministic-2" id="id13"><code class="docutils literal notranslate"><span class="pre">deterministic/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#assertion-1" id="id14"><code class="docutils literal notranslate"><span class="pre">assertion/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#assertion-2" id="id15"><code class="docutils literal notranslate"><span class="pre">assertion/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#quick-check-3" id="id16"><code class="docutils literal notranslate"><span class="pre">quick_check/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#quick-check-2" id="id17"><code class="docutils literal notranslate"><span class="pre">quick_check/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#quick-check-1" id="id18"><code class="docutils literal notranslate"><span class="pre">quick_check/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#benchmark-2" id="id19"><code class="docutils literal notranslate"><span class="pre">benchmark/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#benchmark-reified-3" id="id20"><code class="docutils literal notranslate"><span class="pre">benchmark_reified/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#benchmark-3" id="id21"><code class="docutils literal notranslate"><span class="pre">benchmark/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#benchmark-4" id="id22"><code class="docutils literal notranslate"><span class="pre">benchmark/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#variant-2" id="id23"><code class="docutils literal notranslate"><span class="pre">variant/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#approximately-equal-2" id="id24"><code class="docutils literal notranslate"><span class="pre">approximately_equal/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#approximately-equal-3" id="id25"><code class="docutils literal notranslate"><span class="pre">approximately_equal/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#essentially-equal-3" id="id26"><code class="docutils literal notranslate"><span class="pre">essentially_equal/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#tolerance-equal-4" id="id27"><code class="docutils literal notranslate"><span class="pre">tolerance_equal/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#lgtunit-0-2" id="id28"><code class="docutils literal notranslate"><span class="pre">=~=</span> <span class="pre">/</span> <span class="pre">2</span></code></a></p></li>
<li><p><a class="reference internal" href="#epsilon-1" id="id29"><code class="docutils literal notranslate"><span class="pre">epsilon/1</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#protected-predicates" id="id30">Protected predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#run-tests-0" id="id31"><code class="docutils literal notranslate"><span class="pre">run_tests/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#run-tests-1" id="id32"><code class="docutils literal notranslate"><span class="pre">run_tests/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#run-test-set-0" id="id33"><code class="docutils literal notranslate"><span class="pre">run_test_set/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#run-quick-check-tests-5" id="id34"><code class="docutils literal notranslate"><span class="pre">run_quick_check_tests/5</span></code></a></p></li>
<li><p><a class="reference internal" href="#condition-0" id="id35"><code class="docutils literal notranslate"><span class="pre">condition/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#setup-0" id="id36"><code class="docutils literal notranslate"><span class="pre">setup/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#cleanup-0" id="id37"><code class="docutils literal notranslate"><span class="pre">cleanup/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#make-1" id="id38"><code class="docutils literal notranslate"><span class="pre">make/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#note-1" id="id39"><code class="docutils literal notranslate"><span class="pre">note/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#file-path-2" id="id40"><code class="docutils literal notranslate"><span class="pre">file_path/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#suppress-text-output-0" id="id41"><code class="docutils literal notranslate"><span class="pre">suppress_text_output/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#suppress-binary-output-0" id="id42"><code class="docutils literal notranslate"><span class="pre">suppress_binary_output/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-text-input-3" id="id43"><code class="docutils literal notranslate"><span class="pre">set_text_input/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-text-input-2" id="id44"><code class="docutils literal notranslate"><span class="pre">set_text_input/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-text-input-1" id="id45"><code class="docutils literal notranslate"><span class="pre">set_text_input/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-text-input-2" id="id46"><code class="docutils literal notranslate"><span class="pre">check_text_input/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-text-input-1" id="id47"><code class="docutils literal notranslate"><span class="pre">check_text_input/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-input-assertion-3" id="id48"><code class="docutils literal notranslate"><span class="pre">text_input_assertion/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-input-assertion-2" id="id49"><code class="docutils literal notranslate"><span class="pre">text_input_assertion/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#clean-text-input-0" id="id50"><code class="docutils literal notranslate"><span class="pre">clean_text_input/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-binary-input-3" id="id51"><code class="docutils literal notranslate"><span class="pre">set_binary_input/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-binary-input-2" id="id52"><code class="docutils literal notranslate"><span class="pre">set_binary_input/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-binary-input-1" id="id53"><code class="docutils literal notranslate"><span class="pre">set_binary_input/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-binary-input-2" id="id54"><code class="docutils literal notranslate"><span class="pre">check_binary_input/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-binary-input-1" id="id55"><code class="docutils literal notranslate"><span class="pre">check_binary_input/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#binary-input-assertion-3" id="id56"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#binary-input-assertion-2" id="id57"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#clean-binary-input-0" id="id58"><code class="docutils literal notranslate"><span class="pre">clean_binary_input/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-text-output-3" id="id59"><code class="docutils literal notranslate"><span class="pre">set_text_output/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-text-output-2" id="id60"><code class="docutils literal notranslate"><span class="pre">set_text_output/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-text-output-1" id="id61"><code class="docutils literal notranslate"><span class="pre">set_text_output/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-text-output-3" id="id62"><code class="docutils literal notranslate"><span class="pre">check_text_output/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-text-output-2" id="id63"><code class="docutils literal notranslate"><span class="pre">check_text_output/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-text-output-1" id="id64"><code class="docutils literal notranslate"><span class="pre">check_text_output/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-output-assertion-4" id="id65"><code class="docutils literal notranslate"><span class="pre">text_output_assertion/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-output-assertion-3" id="id66"><code class="docutils literal notranslate"><span class="pre">text_output_assertion/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-output-assertion-2" id="id67"><code class="docutils literal notranslate"><span class="pre">text_output_assertion/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-output-contents-3" id="id68"><code class="docutils literal notranslate"><span class="pre">text_output_contents/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-output-contents-2" id="id69"><code class="docutils literal notranslate"><span class="pre">text_output_contents/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-output-contents-1" id="id70"><code class="docutils literal notranslate"><span class="pre">text_output_contents/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#clean-text-output-0" id="id71"><code class="docutils literal notranslate"><span class="pre">clean_text_output/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-binary-output-3" id="id72"><code class="docutils literal notranslate"><span class="pre">set_binary_output/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-binary-output-2" id="id73"><code class="docutils literal notranslate"><span class="pre">set_binary_output/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#set-binary-output-1" id="id74"><code class="docutils literal notranslate"><span class="pre">set_binary_output/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-binary-output-2" id="id75"><code class="docutils literal notranslate"><span class="pre">check_binary_output/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-binary-output-1" id="id76"><code class="docutils literal notranslate"><span class="pre">check_binary_output/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#binary-output-assertion-3" id="id77"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#binary-output-assertion-2" id="id78"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#binary-output-contents-2" id="id79"><code class="docutils literal notranslate"><span class="pre">binary_output_contents/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#binary-output-contents-1" id="id80"><code class="docutils literal notranslate"><span class="pre">binary_output_contents/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#clean-binary-output-0" id="id81"><code class="docutils literal notranslate"><span class="pre">clean_binary_output/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#create-text-file-3" id="id82"><code class="docutils literal notranslate"><span class="pre">create_text_file/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#create-text-file-2" id="id83"><code class="docutils literal notranslate"><span class="pre">create_text_file/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#create-binary-file-2" id="id84"><code class="docutils literal notranslate"><span class="pre">create_binary_file/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-text-file-3" id="id85"><code class="docutils literal notranslate"><span class="pre">check_text_file/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-text-file-2" id="id86"><code class="docutils literal notranslate"><span class="pre">check_text_file/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-file-assertion-4" id="id87"><code class="docutils literal notranslate"><span class="pre">text_file_assertion/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#text-file-assertion-3" id="id88"><code class="docutils literal notranslate"><span class="pre">text_file_assertion/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#check-binary-file-2" id="id89"><code class="docutils literal notranslate"><span class="pre">check_binary_file/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#binary-file-assertion-3" id="id90"><code class="docutils literal notranslate"><span class="pre">binary_file_assertion/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#clean-file-1" id="id91"><code class="docutils literal notranslate"><span class="pre">clean_file/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#clean-directory-1" id="id92"><code class="docutils literal notranslate"><span class="pre">clean_directory/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#closed-input-stream-2" id="id93"><code class="docutils literal notranslate"><span class="pre">closed_input_stream/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#closed-output-stream-2" id="id94"><code class="docutils literal notranslate"><span class="pre">closed_output_stream/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#stream-position-1" id="id95"><code class="docutils literal notranslate"><span class="pre">stream_position/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#test-2" id="id96"><code class="docutils literal notranslate"><span class="pre">test/2</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#private-predicates" id="id97">Private predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#running-test-sets-0" id="id98"><code class="docutils literal notranslate"><span class="pre">running_test_sets_/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#test-3" id="id99"><code class="docutils literal notranslate"><span class="pre">test/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#auxiliary-predicate-counter-1" id="id100"><code class="docutils literal notranslate"><span class="pre">auxiliary_predicate_counter_/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#id2" id="id101"><code class="docutils literal notranslate"><span class="pre">test_/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#selected-test-1" id="id102"><code class="docutils literal notranslate"><span class="pre">selected_test_/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#skipped-1" id="id103"><code class="docutils literal notranslate"><span class="pre">skipped_/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#passed-3" id="id104"><code class="docutils literal notranslate"><span class="pre">passed_/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#failed-3" id="id105"><code class="docutils literal notranslate"><span class="pre">failed_/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#flaky-1" id="id106"><code class="docutils literal notranslate"><span class="pre">flaky_/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#fired-3" id="id107"><code class="docutils literal notranslate"><span class="pre">fired_/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#covered-4" id="id108"><code class="docutils literal notranslate"><span class="pre">covered_/4</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#operators" id="id109">Operators</a></p>
<ul>
<li><p><a class="reference internal" href="#op-700-xfx" id="id110"><code class="docutils literal notranslate"><span class="pre">op(700,xfx,=~=)</span></code></a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="public-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Public predicates</a><a class="headerlink" href="#public-predicates" title="Link to this heading"></a></h2>
<section id="cover-1">
<span id="lgtunit-0-cover-1"></span><span id="index-1"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">cover/1</span></code></a><a class="headerlink" href="#cover-1" title="Link to this heading"></a></h3>
<p>Declares entities being tested for which code coverage information should be collected.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">cover(Entity)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">cover(?entity_identifier)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="run-0">
<span id="lgtunit-0-run-0"></span><span id="index-2"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run/0</span></code></a><a class="headerlink" href="#run-0" title="Link to this heading"></a></h3>
<p>Runs the unit tests, writing the results to the current output stream.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="run-1">
<span id="lgtunit-0-run-1"></span><span id="index-3"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run/1</span></code></a><a class="headerlink" href="#run-1" title="Link to this heading"></a></h3>
<p>Runs a unit test or a list of unit tests, writing the results to the current output stream. Runs the global setup and cleanup steps when defined. Fails when given a partial list of tests or when one of the test identifiers is not valid.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run(Tests)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run(++callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">run(++list(callable))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="run-2">
<span id="lgtunit-0-run-2"></span><span id="index-4"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run/2</span></code></a><a class="headerlink" href="#run-2" title="Link to this heading"></a></h3>
<p>Runs the unit tests, writing the results to the specified file. Mode can be either <code class="docutils literal notranslate"><span class="pre">write</span></code> (to create a new file) or <code class="docutils literal notranslate"><span class="pre">append</span></code> (to add results to an existing file).</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run(File,Mode)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="run-test-sets-1">
<span id="lgtunit-0-run-test-sets-1"></span><span id="index-5"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run_test_sets/1</span></code></a><a class="headerlink" href="#run-test-sets-1" title="Link to this heading"></a></h3>
<p>Runs two or more test sets as a unified set generating a single code coverage report if one is requested. When there is a single test set, it is equivalent to sending the message <code class="docutils literal notranslate"><span class="pre">run/0</span></code> to the test set. Trivially succeeds when the argument is an empty list.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_test_sets(TestObjects)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_test_sets(+list(object))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">TestObjects</span></code> is a partial list or a list with an element which is a variable:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">instantiation_error</span></code></div>
</div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">TestObjects</span></code> is neither a partial list nor a list:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">type_error(list(object),TestObjects)</span></code></div>
</div>
<div class="line">An element <code class="docutils literal notranslate"><span class="pre">TestObject</span></code> of the <code class="docutils literal notranslate"><span class="pre">TestObjects</span></code> list is not an existing object:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">existence_error(object,TestObject)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="test-1">
<span id="lgtunit-0-test-1"></span><span id="index-6"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">test/1</span></code></a><a class="headerlink" href="#test-1" title="Link to this heading"></a></h3>
<p>Enumerates, by backtracking, the identifiers of all defined unit tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test(Identifier)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test(?callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="number-of-tests-1">
<span id="lgtunit-0-number-of-tests-1"></span><span id="index-7"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">number_of_tests/1</span></code></a><a class="headerlink" href="#number-of-tests-1" title="Link to this heading"></a></h3>
<p>Number of defined unit tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">number_of_tests(NumerOfTests)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">number_of_tests(?integer)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="deterministic-1">
<span id="lgtunit-0-deterministic-1"></span><span id="index-8"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">deterministic/1</span></code></a><a class="headerlink" href="#deterministic-1" title="Link to this heading"></a></h3>
<p>True if the goal succeeds once without leaving choice-points.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">deterministic(Goal)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">deterministic(0)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">deterministic(+callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="deterministic-2">
<span id="lgtunit-0-deterministic-2"></span><span id="index-9"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">deterministic/2</span></code></a><a class="headerlink" href="#deterministic-2" title="Link to this heading"></a></h3>
<p>Reified version of the <code class="docutils literal notranslate"><span class="pre">deterministic/1</span></code> predicate. True if the goal succeeds. Returns a boolean value (<code class="docutils literal notranslate"><span class="pre">true</span></code> or <code class="docutils literal notranslate"><span class="pre">false</span></code>) indicating if the goal succeeded without leaving choice-points.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">deterministic(Goal,Deterministic)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">deterministic(0,*)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">deterministic(+callable,--atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="assertion-1">
<span id="lgtunit-0-assertion-1"></span><span id="index-10"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">assertion/1</span></code></a><a class="headerlink" href="#assertion-1" title="Link to this heading"></a></h3>
<p>True if the assertion goal succeeds. Throws an error using the assertion goal as argument if the assertion goal throws an error or fails.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion(Assertion)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion(::)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion(&#64;callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line">Assertion goal fails:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion_failure(Assertion)</span></code></div>
</div>
<div class="line">Assertion goal throws Error:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion_error(Assertion,Error)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="assertion-2">
<span id="lgtunit-0-assertion-2"></span><span id="index-11"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">assertion/2</span></code></a><a class="headerlink" href="#assertion-2" title="Link to this heading"></a></h3>
<p>True if the assertion goal succeeds. Throws an error using the description as argument if the assertion goal throws an error or fails. The description argument helps to distinguish between different assertions in the same test body.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion(Description,Assertion)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion(*,0)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion(+nonvar,&#64;callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Exceptions:</strong></div>
<div class="line-block">
<div class="line">Assertion goal fails:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion_failure(Description)</span></code></div>
</div>
<div class="line">Assertion goal throws Error:</div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">assertion_error(Description,Error)</span></code></div>
</div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="quick-check-3">
<span id="lgtunit-0-quick-check-3"></span><span id="index-12"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">quick_check/3</span></code></a><a class="headerlink" href="#quick-check-3" title="Link to this heading"></a></h3>
<p>Reified version of the <code class="docutils literal notranslate"><span class="pre">quick_check/2</span></code> predicate. Reports <code class="docutils literal notranslate"><span class="pre">passed(SequenceSeed,Discarded,Labels)</span></code>, <code class="docutils literal notranslate"><span class="pre">failed(Goal,SequenceSeed,TestSeed)</span></code>, <code class="docutils literal notranslate"><span class="pre">error(Error,Goal,SequenceSeed,TestSeed)</span></code>, or <code class="docutils literal notranslate"><span class="pre">broken(Why,Culprit)</span></code>. <code class="docutils literal notranslate"><span class="pre">Goal</span></code> is the failed test.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(Template,Result,Options)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(::,*,::)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(&#64;callable,-callable,++list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
</div>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">SequenceSeed</span></code> argument: Can be used to re-run the same exact sequence of pseudo-random tests by using the <code class="docutils literal notranslate"><span class="pre">rs/1</span></code> option after changes to the code being tested.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">TestSeed</span></code> argument: Can be used to re-run the test that failed by using the <code class="docutils literal notranslate"><span class="pre">rs/1</span></code> option after changes to the code being tested.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Discarded</span></code> argument: Number of generated tests that were discarded for failing to comply a pre-condition specified using the <code class="docutils literal notranslate"><span class="pre">pc/1</span></code> option.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Labels</span></code> argument: List of pairs <code class="docutils literal notranslate"><span class="pre">Label-N</span></code> where <code class="docutils literal notranslate"><span class="pre">N</span></code> is the number of generated tests that are classified as <code class="docutils literal notranslate"><span class="pre">Label</span></code> by a closure specified using the <code class="docutils literal notranslate"><span class="pre">l/1</span></code> option.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">broken(Why,Culprit)</span></code> result: This result signals a broken setup. For example, an invalid template, a broken pre-condition or label goal, or broken test generation.</p></li>
</ul>
</div></blockquote>
<hr class="docutils" />
</section>
<section id="quick-check-2">
<span id="lgtunit-0-quick-check-2"></span><span id="index-13"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">quick_check/2</span></code></a><a class="headerlink" href="#quick-check-2" title="Link to this heading"></a></h3>
<p>Generates and runs random tests for a predicate given its mode template and a set of options. Fails when a generated test fails printing the test. Also fails on an invalid option, printing the option.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(Template,Options)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(::,::)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(&#64;callable,++list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
</div>
<blockquote>
<div><ul class="simple">
<li><p>Number of tests: Use the <code class="docutils literal notranslate"><span class="pre">n(NumberOfTests)</span></code> option to specify the number of random tests. Default is 100.</p></li>
<li><p>Maximum number of shrink operations: Use the <code class="docutils literal notranslate"><span class="pre">s(MaxShrinks)</span></code> option to specify the number of shrink operations when a counter example is found. Default is 64.</p></li>
<li><p>Type edge cases: Use the <code class="docutils literal notranslate"><span class="pre">ec(Boolean)</span></code> option to specify if type edge cases are tested (before generating random tests). Default is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p></li>
<li><p>Starting seed: Use the <code class="docutils literal notranslate"><span class="pre">rs(Seed)</span></code> option to specify the random generator starting seed to be used when generating tests. No default. Seeds should be regarded as opaque terms.</p></li>
<li><p>Test generation filtering: Use the <code class="docutils literal notranslate"><span class="pre">pc/1</span></code> option to specify a pre-condition closure for filtering generated tests (extended with the test arguments; no default).</p></li>
<li><p>Generated tests classification: Use the <code class="docutils literal notranslate"><span class="pre">l/1</span></code> option to specify a label closure for classifying the generated tests (extended with the test arguments plus the labels argument; no default). The labelling predicate can return a single test label or a list of test labels.</p></li>
<li><p>Verbose test generation: Use the <code class="docutils literal notranslate"><span class="pre">v(Boolean)</span></code> option to specify verbose reporting of generated random tests. Default is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p></li>
<li><p>Progress bar: Use the <code class="docutils literal notranslate"><span class="pre">pb(Boolean,Tick)</span></code> option to print a progress bar for the executed tests, advancing at every <code class="docutils literal notranslate"><span class="pre">Tick</span></code> tests. Default is <code class="docutils literal notranslate"><span class="pre">false</span></code>. Only applies when the verbose option is false.</p></li>
</ul>
</div></blockquote>
<hr class="docutils" />
</section>
<section id="quick-check-1">
<span id="lgtunit-0-quick-check-1"></span><span id="index-14"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">quick_check/1</span></code></a><a class="headerlink" href="#quick-check-1" title="Link to this heading"></a></h3>
<p>Generates and runs random tests using default options for a predicate given its mode template. Fails when a generated test fails printing the test.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(Template)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">quick_check(&#64;callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="benchmark-2">
<span id="lgtunit-0-benchmark-2"></span><span id="index-15"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">benchmark/2</span></code></a><a class="headerlink" href="#benchmark-2" title="Link to this heading"></a></h3>
<p>Benchmarks a goal and returns the total execution time in seconds. Uses CPU clock. Goals that may throw an exception should be wrapped by the <code class="docutils literal notranslate"><span class="pre">catch/3</span></code> control construct.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(Goal,Time)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(0,*)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(+callable,-float)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="benchmark-reified-3">
<span id="lgtunit-0-benchmark-reified-3"></span><span id="index-16"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">benchmark_reified/3</span></code></a><a class="headerlink" href="#benchmark-reified-3" title="Link to this heading"></a></h3>
<p>Benchmarks a goal and returns the total execution time in seconds plus its result (<code class="docutils literal notranslate"><span class="pre">success</span></code>, <code class="docutils literal notranslate"><span class="pre">failure</span></code>, or <code class="docutils literal notranslate"><span class="pre">error(Error))</span></code>. Uses CPU clock.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark_reified(Goal,Time,Result)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark_reified(0,*,*)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark_reified(+callable,-float,-callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="benchmark-3">
<span id="lgtunit-0-benchmark-3"></span><span id="index-17"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">benchmark/3</span></code></a><a class="headerlink" href="#benchmark-3" title="Link to this heading"></a></h3>
<p>Benchmarks a goal by repeating it the specified number of times and returning the total execution time in seconds. Uses CPU clock. Goals that may throw an exception should be wrapped by the <code class="docutils literal notranslate"><span class="pre">catch/3</span></code> control construct.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(Goal,Repetitions,Time)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(0,*,*)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(&#64;callable,+positive_integer,-float)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="benchmark-4">
<span id="lgtunit-0-benchmark-4"></span><span id="index-18"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">benchmark/4</span></code></a><a class="headerlink" href="#benchmark-4" title="Link to this heading"></a></h3>
<p>Benchmarks a goal by repeating it the specified number of times and returning the total execution time in seconds using the given clock (<code class="docutils literal notranslate"><span class="pre">cpu</span></code> or <code class="docutils literal notranslate"><span class="pre">wall</span></code>). Goals that may throw an exception should be wrapped by the <code class="docutils literal notranslate"><span class="pre">catch/3</span></code> control construct.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(Goal,Repetitions,Clock,Time)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(0,*,*,*)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">benchmark(&#64;callable,+positive_integer,+atom,-float)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="variant-2">
<span id="lgtunit-0-variant-2"></span><span id="index-19"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">variant/2</span></code></a><a class="headerlink" href="#variant-2" title="Link to this heading"></a></h3>
<p>True when the two arguments are a variant of each other. I.e. if is possible to rename the term variables to make them identical. Useful for checking expected test results that contain variables.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">variant(Term1,Term2)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">variant(&#64;term,&#64;term)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="approximately-equal-2">
<span id="lgtunit-0-approximately-equal-2"></span><span id="index-20"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">approximately_equal/2</span></code></a><a class="headerlink" href="#approximately-equal-2" title="Link to this heading"></a></h3>
<p>Compares two numbers for approximate equality given the <code class="docutils literal notranslate"><span class="pre">epsilon</span></code> arithmetic constant value using the de facto standard formula <code class="docutils literal notranslate"><span class="pre">abs(Number1</span> <span class="pre">-</span> <span class="pre">Number2)</span> <span class="pre">=&lt;</span> <span class="pre">max(abs(Number1),</span> <span class="pre">abs(Number2))</span> <span class="pre">*</span> <span class="pre">epsilon</span></code>. Type-checked.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">approximately_equal(Number1,Number2)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">approximately_equal(+number,+number)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="approximately-equal-3">
<span id="lgtunit-0-approximately-equal-3"></span><span id="index-21"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">approximately_equal/3</span></code></a><a class="headerlink" href="#approximately-equal-3" title="Link to this heading"></a></h3>
<p>Compares two numbers for approximate equality given a user-defined epsilon value using the de facto standard formula <code class="docutils literal notranslate"><span class="pre">abs(Number1</span> <span class="pre">-</span> <span class="pre">Number2)</span> <span class="pre">=&lt;</span> <span class="pre">max(abs(Number1),</span> <span class="pre">abs(Number2))</span> <span class="pre">*</span> <span class="pre">Epsilon</span></code>. Type-checked.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">approximately_equal(Number1,Number2,Epsilon)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">approximately_equal(+number,+number,+number)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
</div>
<blockquote>
<div><ul class="simple">
<li><p>Epsilon range: Epsilon should be the <code class="docutils literal notranslate"><span class="pre">epsilon</span></code> arithmetic constant value or a small multiple of it. Only use a larger value if a greater error is expected.</p></li>
<li><p>Comparison with essential equality: For the same epsilon value, approximate equality is weaker requirement than essential equality.</p></li>
</ul>
</div></blockquote>
<hr class="docutils" />
</section>
<section id="essentially-equal-3">
<span id="lgtunit-0-essentially-equal-3"></span><span id="index-22"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">essentially_equal/3</span></code></a><a class="headerlink" href="#essentially-equal-3" title="Link to this heading"></a></h3>
<p>Compares two numbers for essential equality given an epsilon value using the de facto standard formula <code class="docutils literal notranslate"><span class="pre">abs(Number1</span> <span class="pre">-</span> <span class="pre">Number2)</span> <span class="pre">=&lt;</span> <span class="pre">min(abs(Number1),</span> <span class="pre">abs(Number2))</span> <span class="pre">*</span> <span class="pre">Epsilon</span></code>. Type-checked.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">essentially_equal(Number1,Number2,Epsilon)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">essentially_equal(+number,+number,+number)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
</div>
<blockquote>
<div><ul class="simple">
<li><p>Comparison with approximate equality: For the same epsilon value, essential equality is a stronger requirement than approximate equality.</p></li>
</ul>
</div></blockquote>
<hr class="docutils" />
</section>
<section id="tolerance-equal-4">
<span id="lgtunit-0-tolerance-equal-4"></span><span id="index-23"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">tolerance_equal/4</span></code></a><a class="headerlink" href="#tolerance-equal-4" title="Link to this heading"></a></h3>
<p>Compares two numbers for close equality given relative and absolute tolerances using the de facto standard formula <code class="docutils literal notranslate"><span class="pre">abs(Number1</span> <span class="pre">-</span> <span class="pre">Number2)</span> <span class="pre">=&lt;</span> <span class="pre">max(RelativeTolerance</span> <span class="pre">*</span> <span class="pre">max(abs(Number1),</span> <span class="pre">abs(Number2)),</span> <span class="pre">AbsoluteTolerance)</span></code>. Type-checked.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">tolerance_equal(Number1,Number2,RelativeTolerance,AbsoluteTolerance)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">tolerance_equal(+number,+number,+number,+number)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="lgtunit-0-2">
<span id="index-24"></span><span id="id1"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">=~=</span> <span class="pre">/</span> <span class="pre">2</span></code></a><a class="headerlink" href="#lgtunit-0-2" title="Link to this heading"></a></h3>
<p>Compares two numbers (or lists of numbers) for approximate equality using <code class="docutils literal notranslate"><span class="pre">100*epsilon</span></code> for the absolute error and, if that fails, <code class="docutils literal notranslate"><span class="pre">99.999%</span></code> accuracy for the relative error. But these precision values may not be adequate for all cases. Type-checked.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">=~=(Number1,Number2)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">=~=(+number,+number)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">=~=(+list(number),+list(number))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="epsilon-1">
<span id="lgtunit-0-epsilon-1"></span><span id="index-25"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">epsilon/1</span></code></a><a class="headerlink" href="#epsilon-1" title="Link to this heading"></a></h3>
<p>Returns the value of epsilon used in the definition of the <code class="docutils literal notranslate"><span class="pre">(=~=)/2</span></code> predicate.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">epsilon(Epsilon)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">epsilon(-float)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="protected-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Protected predicates</a><a class="headerlink" href="#protected-predicates" title="Link to this heading"></a></h2>
<section id="run-tests-0">
<span id="lgtunit-0-run-tests-0"></span><span id="index-26"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run_tests/0</span></code></a><a class="headerlink" href="#run-tests-0" title="Link to this heading"></a></h3>
<p>Runs all defined unit tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_tests</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="run-tests-1">
<span id="lgtunit-0-run-tests-1"></span><span id="index-27"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run_tests/1</span></code></a><a class="headerlink" href="#run-tests-1" title="Link to this heading"></a></h3>
<p>Runs all the tests defined in the given file.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_tests(File)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_tests(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="run-test-set-0">
<span id="lgtunit-0-run-test-set-0"></span><span id="index-28"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run_test_set/0</span></code></a><a class="headerlink" href="#run-test-set-0" title="Link to this heading"></a></h3>
<p>Runs a test set as part of running two or more test sets as a unified set.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_test_set</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="run-quick-check-tests-5">
<span id="lgtunit-0-run-quick-check-tests-5"></span><span id="index-29"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">run_quick_check_tests/5</span></code></a><a class="headerlink" href="#run-quick-check-tests-5" title="Link to this heading"></a></h3>
<p>Runs a QuickCheck test using the given options. Returns the starting seed used to generate the random tests, the number of discarded tests, and the test label statistics.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_quick_check_tests(Template,Options,Seed,Discarded,Labels)</span></code></div>
</div>
<div class="line"><strong>Meta-predicate template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_quick_check_tests(::,::,*,*,*)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">run_quick_check_tests(&#64;callable,+list,--nonvar,--number,--list(pair))</span></code> - <code class="docutils literal notranslate"><span class="pre">one_or_error</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="condition-0">
<span id="lgtunit-0-condition-0"></span><span id="index-30"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">condition/0</span></code></a><a class="headerlink" href="#condition-0" title="Link to this heading"></a></h3>
<p>Verifies conditions for running the tests. Defaults to the goal <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">condition</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="setup-0">
<span id="lgtunit-0-setup-0"></span><span id="index-31"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">setup/0</span></code></a><a class="headerlink" href="#setup-0" title="Link to this heading"></a></h3>
<p>Setup environment before running the test set. Defaults to the goal <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">setup</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="cleanup-0">
<span id="lgtunit-0-cleanup-0"></span><span id="index-32"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">cleanup/0</span></code></a><a class="headerlink" href="#cleanup-0" title="Link to this heading"></a></h3>
<p>Cleanup environment after running the test set. Defaults to the goal <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">cleanup</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="make-1">
<span id="lgtunit-0-make-1"></span><span id="index-33"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">make/1</span></code></a><a class="headerlink" href="#make-1" title="Link to this heading"></a></h3>
<p>Make target for automatically running the test set when calling the <code class="docutils literal notranslate"><span class="pre">logtalk_make/1</span></code> built-in predicate. No default. Possible values are <code class="docutils literal notranslate"><span class="pre">all</span></code> and <code class="docutils literal notranslate"><span class="pre">check</span></code>.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">make(Target)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">make(?atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="note-1">
<span id="lgtunit-0-note-1"></span><span id="index-34"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">note/1</span></code></a><a class="headerlink" href="#note-1" title="Link to this heading"></a></h3>
<p>Note to be printed after the test results. Defaults to the empty atom.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">note(Note)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">note(?atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="file-path-2">
<span id="lgtunit-0-file-path-2"></span><span id="index-35"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">file_path/2</span></code></a><a class="headerlink" href="#file-path-2" title="Link to this heading"></a></h3>
<p>Returns the absolute path for a file path that is relative to the tests object path. When the file path is already an absolute path, it is expanded to resolve any remaining relative file path parts.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">file_path(File,Path)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">file_path(+atom,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-file-1"><span class="std std-ref">clean_file/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-directory-1"><span class="std std-ref">clean_directory/1</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="suppress-text-output-0">
<span id="lgtunit-0-suppress-text-output-0"></span><span id="index-36"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">suppress_text_output/0</span></code></a><a class="headerlink" href="#suppress-text-output-0" title="Link to this heading"></a></h3>
<p>Suppresses text output. Useful to avoid irrelevant text output from predicates being tested to clutter the test logs.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">suppress_text_output</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="suppress-binary-output-0">
<span id="lgtunit-0-suppress-binary-output-0"></span><span id="index-37"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">suppress_binary_output/0</span></code></a><a class="headerlink" href="#suppress-binary-output-0" title="Link to this heading"></a></h3>
<p>Suppresses binary output. Useful to avoid irrelevant binary output from predicates being tested to clutter the test logs.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">suppress_binary_output</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-text-input-3">
<span id="lgtunit-0-set-text-input-3"></span><span id="index-38"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_text_input/3</span></code></a><a class="headerlink" href="#set-text-input-3" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given text contents, and opens it for reading referenced by the given alias and using the additional options. If no <code class="docutils literal notranslate"><span class="pre">eof_action/1</span></code> option is specified, its value will be the default used by the backend compiler.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(Alias,Contents,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(+atom,+atom,+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(+atom,+list(atom),+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-input-assertion-3"><span class="std std-ref">text_input_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-input-2"><span class="std std-ref">check_text_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-input-0"><span class="std std-ref">clean_text_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-text-input-2">
<span id="lgtunit-0-set-text-input-2"></span><span id="index-39"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_text_input/2</span></code></a><a class="headerlink" href="#set-text-input-2" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given text contents, and opens it for reading referenced by the given alias and using the default end-of-file action for the used backend compiler.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(Alias,Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(+atom,+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-input-assertion-3"><span class="std std-ref">text_input_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-input-2"><span class="std std-ref">check_text_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-input-0"><span class="std std-ref">clean_text_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-text-input-1">
<span id="lgtunit-0-set-text-input-1"></span><span id="index-40"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_text_input/1</span></code></a><a class="headerlink" href="#set-text-input-1" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given text contents, opens it for reading using the default end-of-file action for the used backend compiler, and sets the current input stream to the file.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_input(+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-input-assertion-2"><span class="std std-ref">text_input_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-input-1"><span class="std std-ref">check_text_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-input-0"><span class="std std-ref">clean_text_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-text-input-2">
<span id="lgtunit-0-check-text-input-2"></span><span id="index-41"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_text_input/2</span></code></a><a class="headerlink" href="#check-text-input-2" title="Link to this heading"></a></h3>
<p>Checks that the temporary file (referenced by the given alias) being read have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_input(Alias,Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_input(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-2"><span class="std std-ref">set_text_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-2"><span class="std std-ref">set_text_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-text-input-assertion-3"><span class="std std-ref">text_input_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-input-0"><span class="std std-ref">clean_text_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-text-input-1">
<span id="lgtunit-0-check-text-input-1"></span><span id="index-42"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_text_input/1</span></code></a><a class="headerlink" href="#check-text-input-1" title="Link to this heading"></a></h3>
<p>Checks that the temporary file being read have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_input(Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_input(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-1"><span class="std std-ref">set_text_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-text-input-assertion-2"><span class="std std-ref">text_input_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-input-0"><span class="std std-ref">clean_text_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-input-assertion-3">
<span id="lgtunit-0-text-input-assertion-3"></span><span id="index-43"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_input_assertion/3</span></code></a><a class="headerlink" href="#text-input-assertion-3" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file (referenced by the given alias) being read have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_input_assertion(Alias,Contents,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_input_assertion(+atom,+atom,--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-3"><span class="std std-ref">set_text_input/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-input-2"><span class="std std-ref">check_text_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-input-0"><span class="std std-ref">clean_text_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-input-assertion-2">
<span id="lgtunit-0-text-input-assertion-2"></span><span id="index-44"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_input_assertion/2</span></code></a><a class="headerlink" href="#text-input-assertion-2" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file being read have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_input_assertion(Contents,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_input_assertion(+atom,--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-1"><span class="std std-ref">set_text_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-input-1"><span class="std std-ref">check_text_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-input-0"><span class="std std-ref">clean_text_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="clean-text-input-0">
<span id="lgtunit-0-clean-text-input-0"></span><span id="index-45"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">clean_text_input/0</span></code></a><a class="headerlink" href="#clean-text-input-0" title="Link to this heading"></a></h3>
<p>Cleans the temporary file used when testing text input.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_text_input</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-3"><span class="std std-ref">set_text_input/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-2"><span class="std std-ref">set_text_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-input-1"><span class="std std-ref">set_text_input/1</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-binary-input-3">
<span id="lgtunit-0-set-binary-input-3"></span><span id="index-46"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_binary_input/3</span></code></a><a class="headerlink" href="#set-binary-input-3" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given binary contents, and opens it for reading referenced by the given alias and using the additional options. If no <code class="docutils literal notranslate"><span class="pre">eof_action/1</span></code> option is specified, its value will be the default used by the backend compiler.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_input(Alias,Bytes,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_input(+atom,+list(byte),+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-input-assertion-3"><span class="std std-ref">binary_input_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-input-2"><span class="std std-ref">check_binary_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-input-0"><span class="std std-ref">clean_binary_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-binary-input-2">
<span id="lgtunit-0-set-binary-input-2"></span><span id="index-47"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_binary_input/2</span></code></a><a class="headerlink" href="#set-binary-input-2" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given binary contents, and opens it for reading referenced by the given alias and using the default end-of-file action for the used backend compiler.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_input(Alias,Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_input(+atom,+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-input-assertion-3"><span class="std std-ref">binary_input_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-input-2"><span class="std std-ref">check_binary_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-input-0"><span class="std std-ref">clean_binary_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-binary-input-1">
<span id="lgtunit-0-set-binary-input-1"></span><span id="index-48"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_binary_input/1</span></code></a><a class="headerlink" href="#set-binary-input-1" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given binary contents, and opens it for reading using the default end-of-file action for the used backend compiler, and sets the current input stream to the file.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_input(Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_input(+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-input-assertion-2"><span class="std std-ref">binary_input_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-input-1"><span class="std std-ref">check_binary_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-input-0"><span class="std std-ref">clean_binary_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-binary-input-2">
<span id="lgtunit-0-check-binary-input-2"></span><span id="index-49"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_binary_input/2</span></code></a><a class="headerlink" href="#check-binary-input-2" title="Link to this heading"></a></h3>
<p>Checks that the temporary file (referenced by the given alias) being read have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_input(Alias,Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_input(+atom,+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-3"><span class="std std-ref">set_binary_input/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-2"><span class="std std-ref">set_binary_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-input-assertion-3"><span class="std std-ref">binary_input_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-input-0"><span class="std std-ref">clean_binary_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-binary-input-1">
<span id="lgtunit-0-check-binary-input-1"></span><span id="index-50"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_binary_input/1</span></code></a><a class="headerlink" href="#check-binary-input-1" title="Link to this heading"></a></h3>
<p>Checks that the temporary file being read have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_input(Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_input(+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-input-assertion-2"><span class="std std-ref">binary_input_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-1"><span class="std std-ref">set_binary_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-input-0"><span class="std std-ref">clean_binary_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="binary-input-assertion-3">
<span id="lgtunit-0-binary-input-assertion-3"></span><span id="index-51"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion/3</span></code></a><a class="headerlink" href="#binary-input-assertion-3" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file (referenced by the given alias) being read have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion(Alias,Bytes,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion(+atom,+list(byte),--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-input-2"><span class="std std-ref">check_binary_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-3"><span class="std std-ref">set_binary_input/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-2"><span class="std std-ref">set_binary_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-input-0"><span class="std std-ref">clean_binary_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="binary-input-assertion-2">
<span id="lgtunit-0-binary-input-assertion-2"></span><span id="index-52"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion/2</span></code></a><a class="headerlink" href="#binary-input-assertion-2" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file being read have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion(Bytes,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_input_assertion(+list(byte),--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-input-1"><span class="std std-ref">check_binary_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-1"><span class="std std-ref">set_binary_input/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-input-0"><span class="std std-ref">clean_binary_input/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="clean-binary-input-0">
<span id="lgtunit-0-clean-binary-input-0"></span><span id="index-53"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">clean_binary_input/0</span></code></a><a class="headerlink" href="#clean-binary-input-0" title="Link to this heading"></a></h3>
<p>Cleans the temporary file used when testing binary input.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_binary_input</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-3"><span class="std std-ref">set_binary_input/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-2"><span class="std std-ref">set_binary_input/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-input-1"><span class="std std-ref">set_binary_input/1</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-text-output-3">
<span id="lgtunit-0-set-text-output-3"></span><span id="index-54"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_text_output/3</span></code></a><a class="headerlink" href="#set-text-output-3" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given text contents, and opens it for writing referenced by the given alias and using the additional options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(Alias,Contents,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(+atom,+atom,+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(+atom,+list(atom),+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-output-assertion-4"><span class="std std-ref">text_output_assertion/4</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-output-3"><span class="std std-ref">check_text_output/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-text-output-2">
<span id="lgtunit-0-set-text-output-2"></span><span id="index-55"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_text_output/2</span></code></a><a class="headerlink" href="#set-text-output-2" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given text contents, and referenced by the given alias.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(Alias,Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(+atom,+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-output-assertion-3"><span class="std std-ref">text_output_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-output-2"><span class="std std-ref">check_text_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-text-output-1">
<span id="lgtunit-0-set-text-output-1"></span><span id="index-56"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_text_output/1</span></code></a><a class="headerlink" href="#set-text-output-1" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given text contents, and sets the current output stream to the file.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_text_output(+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-output-assertion-2"><span class="std std-ref">text_output_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-output-1"><span class="std std-ref">check_text_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-text-output-3">
<span id="lgtunit-0-check-text-output-3"></span><span id="index-57"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_text_output/3</span></code></a><a class="headerlink" href="#check-text-output-3" title="Link to this heading"></a></h3>
<p>Checks that the temporary file (open with the given options and alias in the same directory as the tests object) being written have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_output(Alias,Contents,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_output(+atom,+atom,+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-3"><span class="std std-ref">set_text_output/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-text-output-assertion-4"><span class="std std-ref">text_output_assertion/4</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-text-output-2">
<span id="lgtunit-0-check-text-output-2"></span><span id="index-58"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_text_output/2</span></code></a><a class="headerlink" href="#check-text-output-2" title="Link to this heading"></a></h3>
<p>Checks that the temporary file (open with default options and alias in the same directory as the tests object) being written have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_output(Alias,Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_output(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-2"><span class="std std-ref">set_text_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-text-output-assertion-3"><span class="std std-ref">text_output_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-text-output-1">
<span id="lgtunit-0-check-text-output-1"></span><span id="index-59"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_text_output/1</span></code></a><a class="headerlink" href="#check-text-output-1" title="Link to this heading"></a></h3>
<p>Checks that the temporary file being written have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_output(Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_output(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-1"><span class="std std-ref">set_text_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-text-output-assertion-2"><span class="std std-ref">text_output_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-output-assertion-4">
<span id="lgtunit-0-text-output-assertion-4"></span><span id="index-60"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_output_assertion/4</span></code></a><a class="headerlink" href="#text-output-assertion-4" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file (open with the given options and alias in the same directory as the tests object) being written have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_assertion(Alias,Contents,Options,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_assertion(+atom,+atom,+list(stream_option),--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-3"><span class="std std-ref">set_text_output/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-output-3"><span class="std std-ref">check_text_output/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-output-assertion-3">
<span id="lgtunit-0-text-output-assertion-3"></span><span id="index-61"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_output_assertion/3</span></code></a><a class="headerlink" href="#text-output-assertion-3" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file (open with default options and alias in the same directory as the tests object) being written have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_assertion(Alias,Contents,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_assertion(+atom,+atom,--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-2"><span class="std std-ref">set_text_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-output-2"><span class="std std-ref">check_text_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-output-assertion-2">
<span id="lgtunit-0-text-output-assertion-2"></span><span id="index-62"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_output_assertion/2</span></code></a><a class="headerlink" href="#text-output-assertion-2" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file (open with default options in the same directory as the tests object) being written have the expected text contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_assertion(Contents,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_assertion(+atom,--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-1"><span class="std std-ref">set_text_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-output-1"><span class="std std-ref">check_text_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-text-output-0"><span class="std std-ref">clean_text_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-output-contents-3">
<span id="lgtunit-0-text-output-contents-3"></span><span id="index-63"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_output_contents/3</span></code></a><a class="headerlink" href="#text-output-contents-3" title="Link to this heading"></a></h3>
<p>Returns the contents of the temporary file (open with the given options and alias in the same directory as the tests object) being written.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_contents(Alias,Contents,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_contents(+atom,-list(character),+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-output-contents-2">
<span id="lgtunit-0-text-output-contents-2"></span><span id="index-64"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_output_contents/2</span></code></a><a class="headerlink" href="#text-output-contents-2" title="Link to this heading"></a></h3>
<p>Returns the contents of the temporary file (open with default options and alias in the same directory as the tests object) being written.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_contents(Alias,Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_contents(+atom,-list(character))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-output-contents-1">
<span id="lgtunit-0-text-output-contents-1"></span><span id="index-65"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_output_contents/1</span></code></a><a class="headerlink" href="#text-output-contents-1" title="Link to this heading"></a></h3>
<p>Returns the contents of the temporary file (open with default options in the same directory as the tests object) being written.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_contents(Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_output_contents(-list(character))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="clean-text-output-0">
<span id="lgtunit-0-clean-text-output-0"></span><span id="index-66"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">clean_text_output/0</span></code></a><a class="headerlink" href="#clean-text-output-0" title="Link to this heading"></a></h3>
<p>Cleans the temporary file used when testing text output.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_text_output</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-3"><span class="std std-ref">set_text_output/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-2"><span class="std std-ref">set_text_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-text-output-1"><span class="std std-ref">set_text_output/1</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-binary-output-3">
<span id="lgtunit-0-set-binary-output-3"></span><span id="index-67"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_binary_output/3</span></code></a><a class="headerlink" href="#set-binary-output-3" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given binary contents, and opens it for writing referenced by the given alias and using the additional options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_output(Alias,Contents,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_output(+atom,+list(byte),+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-output-assertion-3"><span class="std std-ref">binary_output_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-output-2"><span class="std std-ref">check_binary_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-output-0"><span class="std std-ref">clean_binary_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-binary-output-2">
<span id="lgtunit-0-set-binary-output-2"></span><span id="index-68"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_binary_output/2</span></code></a><a class="headerlink" href="#set-binary-output-2" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given binary contents, and opens it for writing referenced with the given alias.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_output(Alias,Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_output(+atom,+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-output-assertion-3"><span class="std std-ref">binary_output_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-output-2"><span class="std std-ref">check_binary_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-output-0"><span class="std std-ref">clean_binary_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="set-binary-output-1">
<span id="lgtunit-0-set-binary-output-1"></span><span id="index-69"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">set_binary_output/1</span></code></a><a class="headerlink" href="#set-binary-output-1" title="Link to this heading"></a></h3>
<p>Creates a temporary file, in the same directory as the tests object, with the given binary contents, and sets the current output stream to the file.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_output(Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">set_binary_output(+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-output-assertion-2"><span class="std std-ref">binary_output_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-output-1"><span class="std std-ref">check_binary_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-output-0"><span class="std std-ref">clean_binary_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-binary-output-2">
<span id="lgtunit-0-check-binary-output-2"></span><span id="index-70"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_binary_output/2</span></code></a><a class="headerlink" href="#check-binary-output-2" title="Link to this heading"></a></h3>
<p>Checks that the temporary file (referenced by the given alias) have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_output(Alias,Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_output(+atom,+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-3"><span class="std std-ref">set_binary_output/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-2"><span class="std std-ref">set_binary_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-output-assertion-3"><span class="std std-ref">binary_output_assertion/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-output-0"><span class="std std-ref">clean_binary_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-binary-output-1">
<span id="lgtunit-0-check-binary-output-1"></span><span id="index-71"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_binary_output/1</span></code></a><a class="headerlink" href="#check-binary-output-1" title="Link to this heading"></a></h3>
<p>Checks that the temporary file (open in the same directory as the tests object) have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_output(Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_output(+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-1"><span class="std std-ref">set_binary_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-output-assertion-2"><span class="std std-ref">binary_output_assertion/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-output-0"><span class="std std-ref">clean_binary_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="binary-output-assertion-3">
<span id="lgtunit-0-binary-output-assertion-3"></span><span id="index-72"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion/3</span></code></a><a class="headerlink" href="#binary-output-assertion-3" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file (referenced by the given alias) have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion(Alias,Bytes,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion(+atom,+list(byte),--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-2"><span class="std std-ref">set_binary_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-output-2"><span class="std std-ref">check_binary_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-output-0"><span class="std std-ref">clean_binary_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="binary-output-assertion-2">
<span id="lgtunit-0-binary-output-assertion-2"></span><span id="index-73"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion/2</span></code></a><a class="headerlink" href="#binary-output-assertion-2" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the temporary file (open in the same directory as the tests object) have the expected binary contents.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion(Bytes,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_assertion(+list(byte),--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-1"><span class="std std-ref">set_binary_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-output-1"><span class="std std-ref">check_binary_output/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-binary-output-0"><span class="std std-ref">clean_binary_output/0</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="binary-output-contents-2">
<span id="lgtunit-0-binary-output-contents-2"></span><span id="index-74"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">binary_output_contents/2</span></code></a><a class="headerlink" href="#binary-output-contents-2" title="Link to this heading"></a></h3>
<p>Returns the binary contents of the temporary file (referenced by the given alias) being written.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_contents(Alias,Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_contents(+atom,-list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="binary-output-contents-1">
<span id="lgtunit-0-binary-output-contents-1"></span><span id="index-75"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">binary_output_contents/1</span></code></a><a class="headerlink" href="#binary-output-contents-1" title="Link to this heading"></a></h3>
<p>Returns the binary contents of the temporary file being written.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_contents(Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_output_contents(-list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="clean-binary-output-0">
<span id="lgtunit-0-clean-binary-output-0"></span><span id="index-76"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">clean_binary_output/0</span></code></a><a class="headerlink" href="#clean-binary-output-0" title="Link to this heading"></a></h3>
<p>Cleans the temporary file used when testing binary output.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_binary_output</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-3"><span class="std std-ref">set_binary_output/3</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-2"><span class="std std-ref">set_binary_output/2</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-set-binary-output-1"><span class="std std-ref">set_binary_output/1</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="create-text-file-3">
<span id="lgtunit-0-create-text-file-3"></span><span id="index-77"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">create_text_file/3</span></code></a><a class="headerlink" href="#create-text-file-3" title="Link to this heading"></a></h3>
<p>Creates a text file with the given contents. The file is open for writing using the given options. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_text_file(File,Contents,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_text_file(+atom,+atom,+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_text_file(+atom,+list(atom),+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="create-text-file-2">
<span id="lgtunit-0-create-text-file-2"></span><span id="index-78"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">create_text_file/2</span></code></a><a class="headerlink" href="#create-text-file-2" title="Link to this heading"></a></h3>
<p>Creates a text file with the given contents. The file is open for writing using default options. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_text_file(File,Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_text_file(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_text_file(+atom,+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="create-binary-file-2">
<span id="lgtunit-0-create-binary-file-2"></span><span id="index-79"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">create_binary_file/2</span></code></a><a class="headerlink" href="#create-binary-file-2" title="Link to this heading"></a></h3>
<p>Creates a binary file with the given contents. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_binary_file(File,Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">create_binary_file(+atom,+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-text-file-3">
<span id="lgtunit-0-check-text-file-3"></span><span id="index-80"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_text_file/3</span></code></a><a class="headerlink" href="#check-text-file-3" title="Link to this heading"></a></h3>
<p>Checks that the contents of a text file match the expected contents. The file is open for reading using the given options. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_file(File,Contents,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_file(+atom,+atom,+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-file-assertion-4"><span class="std std-ref">text_file_assertion/4</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-text-file-2">
<span id="lgtunit-0-check-text-file-2"></span><span id="index-81"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_text_file/2</span></code></a><a class="headerlink" href="#check-text-file-2" title="Link to this heading"></a></h3>
<p>Checks that the contents of a text file (open for reading using default options) match the expected contents. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_file(File,Contents)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_text_file(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-text-file-assertion-3"><span class="std std-ref">text_file_assertion/3</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-file-assertion-4">
<span id="lgtunit-0-text-file-assertion-4"></span><span id="index-82"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_file_assertion/4</span></code></a><a class="headerlink" href="#text-file-assertion-4" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the given file have the expected text contents. The file is open for reading using the given options. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_file_assertion(File,Contents,Options,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_file_assertion(+atom,+atom,+list(stream_option),--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-file-3"><span class="std std-ref">check_text_file/3</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="text-file-assertion-3">
<span id="lgtunit-0-text-file-assertion-3"></span><span id="index-83"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">text_file_assertion/3</span></code></a><a class="headerlink" href="#text-file-assertion-3" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the given file have the expected text contents. The file is open for reading using default options. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_file_assertion(File,Contents,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">text_file_assertion(+atom,+atom,--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-check-text-file-2"><span class="std std-ref">check_text_file/2</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="check-binary-file-2">
<span id="lgtunit-0-check-binary-file-2"></span><span id="index-84"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">check_binary_file/2</span></code></a><a class="headerlink" href="#check-binary-file-2" title="Link to this heading"></a></h3>
<p>Checks the contents of a binary file match the expected contents. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_file(File,Bytes)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">check_binary_file(+atom,+list(byte))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-binary-file-assertion-3"><span class="std std-ref">binary_file_assertion/3</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="binary-file-assertion-3">
<span id="lgtunit-0-binary-file-assertion-3"></span><span id="index-85"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">binary_file_assertion/3</span></code></a><a class="headerlink" href="#binary-file-assertion-3" title="Link to this heading"></a></h3>
<p>Returns an assertion for checking that the given file have the expected binary contents. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_file_assertion(File,Bytes,Assertion)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">binary_file_assertion(+atom,+list(byte),--callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-check-binary-file-2"><span class="std std-ref">check_binary_file/2</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="clean-file-1">
<span id="lgtunit-0-clean-file-1"></span><span id="index-86"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">clean_file/1</span></code></a><a class="headerlink" href="#clean-file-1" title="Link to this heading"></a></h3>
<p>Closes any existing stream associated with the file and deletes the file if it exists. Relative file paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_file(File)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_file(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-directory-1"><span class="std std-ref">clean_directory/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-file-path-2"><span class="std std-ref">file_path/2</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="clean-directory-1">
<span id="lgtunit-0-clean-directory-1"></span><span id="index-87"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">clean_directory/1</span></code></a><a class="headerlink" href="#clean-directory-1" title="Link to this heading"></a></h3>
<p>Deletes an empty directory if it exists. Relative directory paths are interpreted as relative to the tests object path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_directory(Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">clean_directory(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>See also:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="#lgtunit-0-clean-file-1"><span class="std std-ref">clean_file/1</span></a></div>
<div class="line"><a class="reference internal" href="#lgtunit-0-file-path-2"><span class="std std-ref">file_path/2</span></a></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="closed-input-stream-2">
<span id="lgtunit-0-closed-input-stream-2"></span><span id="index-88"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">closed_input_stream/2</span></code></a><a class="headerlink" href="#closed-input-stream-2" title="Link to this heading"></a></h3>
<p>Opens a temporary file in the same directory as the tests object with the given options for reading, closes it, and returns its stream handle.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">closed_input_stream(Stream,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">closed_input_stream(-stream,+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="closed-output-stream-2">
<span id="lgtunit-0-closed-output-stream-2"></span><span id="index-89"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">closed_output_stream/2</span></code></a><a class="headerlink" href="#closed-output-stream-2" title="Link to this heading"></a></h3>
<p>Opens a temporary file in the same directory as the tests object with the given options for writing, closes it, and returns its stream handle.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">closed_output_stream(Stream,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">closed_output_stream(-stream,+list(stream_option))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="stream-position-1">
<span id="lgtunit-0-stream-position-1"></span><span id="index-90"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">stream_position/1</span></code></a><a class="headerlink" href="#stream-position-1" title="Link to this heading"></a></h3>
<p>Returns a syntactically valid stream position by opening a temporary file in the same directory as the tests object.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">stream_position(Position)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">stream_position(-stream_position)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="test-2">
<span id="lgtunit-0-test-2"></span><span id="index-91"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">test/2</span></code></a><a class="headerlink" href="#test-2" title="Link to this heading"></a></h3>
<p>Table of defined tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test(Identifier,Test)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test(?callable,?compound)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="private-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Private predicates</a><a class="headerlink" href="#private-predicates" title="Link to this heading"></a></h2>
<section id="running-test-sets-0">
<span id="lgtunit-0-running-test-sets-0"></span><span id="index-92"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">running_test_sets_/0</span></code></a><a class="headerlink" href="#running-test-sets-0" title="Link to this heading"></a></h3>
<p>Internal flag used when running two or more test sets as a unified set.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">running_test_sets_</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="test-3">
<span id="lgtunit-0-test-3"></span><span id="index-93"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">test/3</span></code></a><a class="headerlink" href="#test-3" title="Link to this heading"></a></h3>
<p>Compiled unit tests. The list of variables is used to ensure variable sharing between a test with its test options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test(Identifier,Variables,Outcome)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test(?callable,?list(variable),?nonvar)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="auxiliary-predicate-counter-1">
<span id="lgtunit-0-auxiliary-predicate-counter-1"></span><span id="index-94"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">auxiliary_predicate_counter_/1</span></code></a><a class="headerlink" href="#auxiliary-predicate-counter-1" title="Link to this heading"></a></h3>
<p>Counter for generating unique auxiliary predicate names.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">auxiliary_predicate_counter_(Counter)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">auxiliary_predicate_counter_(?integer)</span></code> - <code class="docutils literal notranslate"><span class="pre">one_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="id2">
<span id="index-95"></span><span id="id3"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">test_/2</span></code></a><a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
<p>Table of compiled tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test_(Identifier,Test)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">test_(?callable,?compound)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="selected-test-1">
<span id="lgtunit-0-selected-test-1"></span><span id="index-96"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">selected_test_/1</span></code></a><a class="headerlink" href="#selected-test-1" title="Link to this heading"></a></h3>
<p>Table of selected tests for execution.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">selected_test_(Identifier)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">selected_test_(?callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="skipped-1">
<span id="lgtunit-0-skipped-1"></span><span id="index-97"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">skipped_/1</span></code></a><a class="headerlink" href="#skipped-1" title="Link to this heading"></a></h3>
<p>Counter for skipped tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">skipped_(Counter)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">skipped_(?integer)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="passed-3">
<span id="lgtunit-0-passed-3"></span><span id="index-98"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">passed_/3</span></code></a><a class="headerlink" href="#passed-3" title="Link to this heading"></a></h3>
<p>Counter and total time for passed tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">passed_(Counter,CPUTime,WallTime)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">passed_(?integer,-float,-float)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="failed-3">
<span id="lgtunit-0-failed-3"></span><span id="index-99"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">failed_/3</span></code></a><a class="headerlink" href="#failed-3" title="Link to this heading"></a></h3>
<p>Counter and total time for failed tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">failed_(Counter,CPUTime,WallTime)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">failed_(?integer,-float,-float)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="flaky-1">
<span id="lgtunit-0-flaky-1"></span><span id="index-100"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">flaky_/1</span></code></a><a class="headerlink" href="#flaky-1" title="Link to this heading"></a></h3>
<p>Counter for failed tests that are marked as flaky.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">flaky_(Counter)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">flaky_(?integer)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="fired-3">
<span id="lgtunit-0-fired-3"></span><span id="index-101"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">fired_/3</span></code></a><a class="headerlink" href="#fired-3" title="Link to this heading"></a></h3>
<p>Fired clauses when running the unit tests.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">fired_(Entity,Predicate,Clause)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">fired_(?entity_identifier,?predicate_indicator,?integer)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="covered-4">
<span id="lgtunit-0-covered-4"></span><span id="index-102"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">covered_/4</span></code></a><a class="headerlink" href="#covered-4" title="Link to this heading"></a></h3>
<p>Auxiliary predicate for collecting statistics on clause coverage.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">covered_(Entity,Predicate,Covered,Total)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">covered_(?entity_identifier,?callable,?integer,?integer)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="operators">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Operators</a><a class="headerlink" href="#operators" title="Link to this heading"></a></h2>
<section id="op-700-xfx">
<h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">op(700,xfx,=~=)</span></code></a><a class="headerlink" href="#op-700-xfx" title="Link to this heading"></a></h3>
<div class="line-block">
<div class="line"><strong>Scope:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">public</span></code></div>
</div>
</div>
</section>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="coverage_report_0.html" class="btn btn-neutral float-left" title="coverage_report" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="lgtunit_messages_0.html" class="btn btn-neutral float-right" title="lgtunit_messages" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 1998-2025, Paulo Moura.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>